Represents the states of an EtherCAT slave.
Inheritance Hierarchy
System.Object
IntervalZero.KINGSTAR.Base.Api.SlaveStatus
Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0
Syntax
public class SlaveStatusPublic Class SlaveStatus
The SlaveStatus class exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | SlaveStatus | Initializes a new instance of the SlaveStatus class. |
Fields
| Name | Description | |
|---|---|---|
 | AliasAddress | The alias address of a device, defined in the module EEPROM. |
| CycleTime | The cycle time for a slave. |
| ExplicitId | The explicit ID is an address on an EtherCAT network used to identify an EtherCAT slave. |
| InputLength | The length of the input data read from a device. |
| Name | The name of a device. |
| OutputLength | The length of the output data sent to a device. |
| PhysAddress | The physical address of a device, used by the EtherCAT master to access the slave. |
| ProductCode | The product code of a device. |
| RequestedState | Reads the EtherCAT state from the latest RequestState function call. |
| RevisionNumber | The revision number of a device. |
| SerialNumber | The serial number of a device. |
| SlaveId | The index of a slave array. When EtherCAT is started, this index has the same value as the SlaveId, which corresponds to the position of the slave in the network. Please note that after EtherCAT is started in the Operational (Op) state, any addition or removal of slaves from the network will change the position of the slaves in the network (SlaveId). Nevertheless, the index of the slave will remain the same. Newly added devices will be added in the back of the slave array. For all slaves after the change, the index and SlaveId will no longer match. This behavior is only available for physical devices; simulated devices are inapplicable. Please refer to the use cases in EnableHotConnect for more details. |
| SlotId | For IO-Link devices, a slot is an IO-Link port of an IO-Link master that can be connected to an EtherCAT network. SlotId is the ID of a slot where a module (IO-Link slave) is connected. For CAN devices, it is the CAN ID. For non-modular devices, the values are -1. |
| State | The EtherCAT state of a device. |
| VariableIndexOffset | If you're using multiple-axis servo drives and you want to read the data from one of the axes, you can use this parameter to retrieve the offset value of the SDO object addresses of that axis. |
| VendorId | The vendor ID of a device, given by the EtherCAT Technology Group to the manufacturer of the EtherCAT device. |
See also